类 FoxitPDFSDKPython2.FreeText 继承关系图:

Public 成员函数
def	FreeText ()
	构造函数。

def	FreeText (annot)
	构造函数，使用父类对象。更多...

def	AllowTextOverflow (is_text_overflow)
	决定是否允许自由文本的文本溢出。更多...

def	GetAlignment ()

def	GetCalloutLineEndingStyle ()
	获取标注线起点的线条结束样式。更多...

def	GetCalloutLinePoints ()
	获取标注线点。更多...

def	GetDefaultAppearance ()
	获取默认外观数据。更多...

def	GetFillColor ()
	获取填充颜色。更多...

def	GetInnerRect ()
	获取内部矩形。更多...

def	GetRotation ()
	获取当前旋转值（顺时针）。更多...

def	GetTextMatrix ()

def	Rotate (rotation)
	从当前状态按指定旋转值（顺时针）旋转当前注释。更多...

def	SetAlignment (alignment)

def	SetCalloutLineEndingStyle (ending_style)
	设置标注线起点的线条结束样式。更多...

def	SetCalloutLinePoints (point_array)
	设置标注线的点。更多...

def	SetDefaultAppearance (default_ap)
	设置默认外观数据。更多...

def	SetFillColor (fill_color)
	设置填充颜色。更多...

def	SetInnerRect (inner_rect)
	设置内部矩形。更多...

def	SetRotation (rotation)
	设置旋转值（顺时针）。更多...

def	SetTextMatrix (text_matrix)

Public 成员函数继承自 FoxitPDFSDKPython2.Markup
def	Markup ()
	构造函数

def	AddReply ()
	在回复列表的末尾添加新回复。更多...

def	AddRichText (content, style)
	在末尾添加新的富文本字符串。更多...

def	AddStateAnnot (title, model, state)
	添加新的状态注释。更多...

def	GetBorderOpacity ()
	获取注释的边框透明度。更多...

def	GetCreationDateTime ()
	获取创建日期时间。更多...

def	GetFillOpacity ()
	获取注释的填充透明度。更多...

def	GetGroupElements ()
	从当前标记注释所属的组中获取一个元素（作为标记注释）。更多...

def	GetGroupHeader ()
	获取当前标记注释所属组的头注释（作为主注释）。更多...

def	GetIntent ()
	获取意图名称。更多...

def	GetOpacity ()
	获取不透明度值。更多...

def	GetPopup ()
	获取相关的弹出注释。更多...

def	GetReply (index)
	按索引获取回复。更多...

def	GetReplyCount ()
	计算所有回复。更多...

def	GetRichTextContent (index)
	获取指定索引的富文本字符串的文本字符串。更多...

def	GetRichTextCount ()
	获取富文本字符串的数量。更多...

def	GetRichTextStyle (index)
	获取指定索引的富文本字符串的样式数据。更多...

def	GetStateAnnots (model)
	获取指定状态模型中的所有状态注释。更多...

def	GetSubject ()
	获取主题字符串。更多...

def	GetTitle ()
	获取标题字符串。更多...

def	InsertRichText (index, content, style)
	在指定索引位置插入新的富文本字符串。更多...

def	IsGrouped ()
	检查当前标记注释是否在组中。更多...

def	RemoveAllReplies ()
	删除所有回复。更多...

def	RemoveAllStateAnnots ()
	移除所有状态注释。更多...

def	RemovePopup ()
	删除相关的弹出注释。更多...

def	RemoveReply (index)
	按索引删除回复。更多...

def	RemoveRichText (index)
	移除指定索引的富文本字符串。更多...

def	SetBorderOpacity (opacity)
	设置注释的边框透明度。更多...

def	SetCreationDateTime (date_time)
	设置创建日期时间。更多...

def	SetFillOpacity (opacity)
	设置注释的填充透明度。更多...

def	SetIntent (intent)
	设置意图名称。更多...

def	SetOpacity (opacity)
	设置不透明度值。更多...

def	SetPopup (popup)
	设置相关的弹出注释。更多...

def	SetRichTextContent (index, content)
	设置指定索引的富文本字符串的文本字符串。更多...

def	SetRichTextStyle (index, style)
	设置指定索引的富文本字符串的样式数据。更多...

def	SetSubject (subject)
	设置主题字符串。更多...

def	SetTitle (title)
	设置标题字符串。更多...

def	Ungroup ()
	将当前标记注释从其所属的组中解组。更多...

Public 成员函数继承自 FoxitPDFSDKPython2.Annot
def	Annot ()
	构造函数。

def	Annot (annot)
	构造函数，使用另一个注释对象。更多...

def	GetAppearanceStream (type, appearance_state)
	获取具有指定类型和状态的注释外观流。更多...

def	GetBorderColor ()
	获取边框颜色。更多...

def	GetBorderInfo ()
	获取边框信息。更多...

def	GetContent ()
	获取内容。更多...

def	GetDeviceRect (matrix)
	获取设备坐标系统中的注释矩形。更多...

def	GetDict ()
	获取注释的字典对象。更多...

def	GetDisplayMatrix (page_display_matrix)
	获取显示矩阵，从到目标设备坐标系统。更多...

def	GetFlags ()
	获取注释标志。更多...

def	GetIndex ()
	获取当前注释在其所属页面中的索引。更多...

def	GetModifiedDateTime ()
	获取最后修改日期时间。更多...

def	GetOptionalContent ()
	获取注释可选内容的PDF字典。更多...

def	GetPage ()
	获取相关的PDF页面。更多...

def	GetRect ()
	获取矩形，以表示。更多...

def	GetType ()
	获取当前注释的实际注释类型。更多...

def	GetUniqueID ()
	获取唯一ID。更多...

def	HasProperty (property)
	当前注释是否具有指定的注释属性。更多...

def	IsEmpty ()
	检查当前对象是否为空。更多...

def	IsMarkup ()
	检查当前注释是否为标记注释。更多...

def	Move (rect)
	将当前注释移动到新位置，由中的新矩形指定。更多...

def	Move (rect, is_reset_appearance)
	将当前注释移动到新位置，由中的新矩形指定。更多...

def	RemoveProperty (property)
	删除指定的注释属性。更多...

def	ResetAppearanceStream ()
	重置外观流。更多...

def	SetBorderColor (color)
	设置边框颜色。更多...

def	SetBorderInfo (border)
	设置边框信息。更多...

def	SetContent (content)
	设置内容。更多...

def	SetFlags (flags)
	设置注释标志。更多...

def	SetModifiedDateTime (date_time)
	设置最后修改日期时间。更多...

def	SetUniqueID (unique_id)
	设置唯一ID。更多...

额外继承的成员函数
静态 Public 属性继承自 FoxitPDFSDKPython2.Markup
	e_EndingStyleButt = _fsdk.Markup_e_EndingStyleButt
	端点处垂直于线条本身的短线。

	e_EndingStyleCircle = _fsdk.Markup_e_EndingStyleCircle
	用注释的内部颜色填充的圆形（如果有）。

	e_EndingStyleClosedArrow = _fsdk.Markup_e_EndingStyleClosedArrow
	两条短线以锐角相交（如OpenArrow样式），并由第三条线连接，形成用注释的内部颜色填充的三角形闭合箭头（如果有）。

	e_EndingStyleDiamond = _fsdk.Markup_e_EndingStyleDiamond
	用注释的内部颜色填充的菱形（如果有）。

	e_EndingStyleNone = _fsdk.Markup_e_EndingStyleNone
	无特殊线条端点。

	e_EndingStyleOpenArrow = _fsdk.Markup_e_EndingStyleOpenArrow
	两条短线以锐角相交形成开放箭头。

	e_EndingStyleRClosedArrow = _fsdk.Markup_e_EndingStyleRClosedArrow
	与ClosedArrow方向相反的三角形闭合箭头。

	e_EndingStyleROpenArrow = _fsdk.Markup_e_EndingStyleROpenArrow
	与OpenArrow方向相反的两条短线。

	e_EndingStyleSlash = _fsdk.Markup_e_EndingStyleSlash
	端点处与线条垂直方向约顺时针30度的短线。

	e_EndingStyleSquare = _fsdk.Markup_e_EndingStyleSquare
	用注释的内部颜色填充的正方形（如果有）。

	e_MeasureTypeA = _fsdk.Markup_e_MeasureTypeA
	面积的测量。

	e_MeasureTypeD = _fsdk.Markup_e_MeasureTypeD
	任意方向距离的测量。

	e_MeasureTypeS = _fsdk.Markup_e_MeasureTypeS
	直线斜率的测量。

	e_MeasureTypeT = _fsdk.Markup_e_MeasureTypeT
	角度的测量。

	e_MeasureTypeX = _fsdk.Markup_e_MeasureTypeX
	沿x轴变化的测量。

	e_MeasureTypeY = _fsdk.Markup_e_MeasureTypeY
	沿y轴变化的测量。

	e_StateAccepted = _fsdk.Markup_e_StateAccepted
	（与状态模型FoxitPDFSDKPython2.Markup.e_StateModelReview 一起使用）用户同意更改。

	e_StateCancelled = _fsdk.Markup_e_StateCancelled
	（与状态模型FoxitPDFSDKPython2.Markup.e_StateModelReview 一起使用）更改已被取消。

	e_StateCompleted = _fsdk.Markup_e_StateCompleted
	（与状态模型FoxitPDFSDKPython2.Markup.e_StateModelReview 一起使用）更改已完成。

	e_StateDeferred = _fsdk.Markup_e_StateDeferred
	（与状态模型FoxitPDFSDKPython2.Markup.e_StateModelReview 一起使用）更改已延期。

	e_StateFuture = _fsdk.Markup_e_StateFuture
	（与状态模型FoxitPDFSDKPython2.Markup.e_StateModelReview 一起使用）更改将在将来进行。

	e_StateMarked = _fsdk.Markup_e_StateMarked
	（与状态模型FoxitPDFSDKPython2.Markup.e_StateModelMarked 一起使用）注释已被用户标记。

	e_StateModelMarked = _fsdk.Markup_e_StateModelMarked
	标记注释状态模型：已标记。

	e_StateModelReview = _fsdk.Markup_e_StateModelReview
	标记注释状态模型：审阅。

	e_StateNone = _fsdk.Markup_e_StateNone
	（与状态模型FoxitPDFSDKPython2.Markup.e_StateModelReview 一起使用）用户没有对更改表示任何意见。

	e_StateRejected = _fsdk.Markup_e_StateRejected
	（与状态模型FoxitPDFSDKPython2.Markup.e_StateModelReview 一起使用）用户不同意更改。

	e_StateUnmarked = _fsdk.Markup_e_StateUnmarked
	（与状态模型FoxitPDFSDKPython2.Markup.e_StateModelMarked 一起使用）注释尚未被用户标记。

静态 Public 属性继承自 FoxitPDFSDKPython2.Annot
	e_3D = _fsdk.Annot_e_3D
	注释类型：3D注释。<PDF参考1.7>中的标准注释之一。

	e_AppearanceTypeDown = _fsdk.Annot_e_AppearanceTypeDown
	注释的按下外观。

	e_AppearanceTypeNormal = _fsdk.Annot_e_AppearanceTypeNormal
	注释的正常外观。

	e_AppearanceTypeRollover = _fsdk.Annot_e_AppearanceTypeRollover
	注释的悬停外观。

	e_Caret = _fsdk.Annot_e_Caret
	注释类型：插入符注释。<PDF参考1.7>中的标准注释之一。

	e_Circle = _fsdk.Annot_e_Circle
	注释类型：圆形注释。<PDF参考1.7>中的标准注释之一。

	e_FileAttachment = _fsdk.Annot_e_FileAttachment
	注释类型：文件附件注释。<PDF参考1.7>中的标准注释之一。

	e_FlagHidden = _fsdk.Annot_e_FlagHidden
	注释标志：隐藏。更多...

	e_FlagInvisible = _fsdk.Annot_e_FlagInvisible
	注释标志：不可见。更多...

	e_FlagLocked = _fsdk.Annot_e_FlagLocked
	注释标志：锁定。更多...

	e_FlagLockedContents = _fsdk.Annot_e_FlagLockedContents
	注释标志：锁定内容。更多...

	e_FlagNoRotate = _fsdk.Annot_e_FlagNoRotate
	注释标志：无旋转。更多...

	e_FlagNoView = _fsdk.Annot_e_FlagNoView
	注释标志：无视图。更多...

	e_FlagNoZoom = _fsdk.Annot_e_FlagNoZoom
	注释标志：无缩放。更多...

	e_FlagPrint = _fsdk.Annot_e_FlagPrint
	注释标志：打印。更多...

	e_FlagReadOnly = _fsdk.Annot_e_FlagReadOnly
	注释标志：只读。更多...

	e_FlagToggleNoView = _fsdk.Annot_e_FlagToggleNoView
	注释标志：切换无视图。更多...

	e_FreeText = _fsdk.Annot_e_FreeText
	注释类型：自由文本注释。<PDF参考1.7>中的标准注释之一。

	e_Highlight = _fsdk.Annot_e_Highlight
	注释类型：高亮注释。<PDF参考1.7>中的标准注释之一。

	e_HighlightingInvert = _fsdk.Annot_e_HighlightingInvert
	高亮模式：反转，即反转注释矩形的内容。

	e_HighlightingNone = _fsdk.Annot_e_HighlightingNone
	高亮模式：无高亮。

	e_HighlightingOutline = _fsdk.Annot_e_HighlightingOutline
	高亮模式：轮廓，即反转注释的边框。

	e_HighlightingPush = _fsdk.Annot_e_HighlightingPush
	高亮模式：按下，即显示注释的按下外观（如果有）。

	e_HighlightingToggle = _fsdk.Annot_e_HighlightingToggle
	高亮模式：切换。这仅对小组件注释有用。

	e_Ink = _fsdk.Annot_e_Ink
	注释类型：墨迹注释。<PDF参考1.7>中的标准注释之一。

	e_Line = _fsdk.Annot_e_Line
	注释类型：直线注释。<PDF参考1.7>中的标准注释之一。

	e_Link = _fsdk.Annot_e_Link
	注释类型：链接注释。<PDF参考1.7>中的标准注释之一。

	e_MKEntryBackgroundColor = _fsdk.Annot_e_MKEntryBackgroundColor
	背景颜色条目。MK字典中的"BG"。

	e_MKEntryBorderColor = _fsdk.Annot_e_MKEntryBorderColor
	边框颜色条目。MK字典中的"BC"。

	e_MKEntryDownCaption = _fsdk.Annot_e_MKEntryDownCaption
	按下标题（或备用标题）条目。MK字典中的"AC"。更多...

	e_MKEntryDownIcon = _fsdk.Annot_e_MKEntryDownIcon
	按下图标（或备用图标）条目。MK字典中的"IX"。更多...

	e_MKEntryIconCaptionRelation = _fsdk.Annot_e_MKEntryIconCaptionRelation
	图标和标题关系条目。MK字典中的"TP"。更多...

	e_MKEntryIconFit = _fsdk.Annot_e_MKEntryIconFit
	图标适配信息条目。MK字典中的"IF"。更多...

	e_MKEntryNormalCaption = _fsdk.Annot_e_MKEntryNormalCaption
	正常标题条目。MK字典中的"CA"。更多...

	e_MKEntryNormalIcon = _fsdk.Annot_e_MKEntryNormalIcon
	正常图标条目。MK字典中的"I"。更多...

	e_MKEntryRolloverCaption = _fsdk.Annot_e_MKEntryRolloverCaption
	悬停标题条目。MK字典中的"RC"。更多...

	e_MKEntryRolloverIcon = _fsdk.Annot_e_MKEntryRolloverIcon
	悬停图标条目。MK字典中的"RI"。更多...

	e_MKEntryRotation = _fsdk.Annot_e_MKEntryRotation
	旋转条目。MK字典中的"R"。

	e_MKRelationCaptionAboveIcon = _fsdk.Annot_e_MKRelationCaptionAboveIcon
	标题在图标上方。

	e_MKRelationCaptionBelowIcon = _fsdk.Annot_e_MKRelationCaptionBelowIcon
	标题在图标下方。

	e_MKRelationCaptionLeft = _fsdk.Annot_e_MKRelationCaptionLeft
	标题在图标左侧。

	e_MKRelationCaptionOvrlayOnIcon = _fsdk.Annot_e_MKRelationCaptionOvrlayOnIcon
	标题直接覆盖在图标上。

	e_MKRelationCaptionRight = _fsdk.Annot_e_MKRelationCaptionRight
	标题在图标右侧。

	e_MKRelationNoCaption = _fsdk.Annot_e_MKRelationNoCaption
	无标题；仅图标。

	e_MKRelationNoIcon = _fsdk.Annot_e_MKRelationNoIcon
	无图标；仅标题。

	e_Movie = _fsdk.Annot_e_Movie
	注释类型：电影注释。<PDF参考1.7>中的标准注释之一。

	e_Note = _fsdk.Annot_e_Note
	注释类型：注记注释，即"文本"注释 - <PDF参考1.7>中的标准注释之一。

	e_PagingSeal = _fsdk.Annot_e_PagingSeal
	注释类型：分页印章注释。福昕PDF SDK自定义注释类型（非标准注释类型）。

	e_Polygon = _fsdk.Annot_e_Polygon
	注释类型：多边形注释。<PDF参考1.7>中的标准注释之一。

	e_PolyLine = _fsdk.Annot_e_PolyLine
	注释类型：折线注释。<PDF参考1.7>中的标准注释之一。

	e_Popup = _fsdk.Annot_e_Popup
	注释类型：弹出注释。<PDF参考1.7>中的标准注释之一。

	e_PrinterMark = _fsdk.Annot_e_PrinterMark
	注释类型：印刷标记注释。<PDF参考1.7>中的标准注释之一。

	e_PropertyBorderColor = _fsdk.Annot_e_PropertyBorderColor
	注释属性：边框颜色。更多...

	e_PropertyCreationDate = _fsdk.Annot_e_PropertyCreationDate
	注释属性：创建日期。更多...

	e_PropertyFillColor = _fsdk.Annot_e_PropertyFillColor
	注释属性：填充颜色更多...

	e_PropertyModifiedDate = _fsdk.Annot_e_PropertyModifiedDate
	注释属性：修改日期。

	e_PSInk = _fsdk.Annot_e_PSInk
	注释类型：压力敏感墨迹注释。

	e_Redact = _fsdk.Annot_e_Redact
	注释类型：编辑注释。

	e_RichMedia = _fsdk.Annot_e_RichMedia
	注释类型：富媒体注释。

	e_Screen = _fsdk.Annot_e_Screen
	注释类型：屏幕注释。<PDF参考1.7>中的标准注释之一。

	e_Sound = _fsdk.Annot_e_Sound
	注释类型：声音注释。<PDF参考1.7>中的标准注释之一。

	e_Square = _fsdk.Annot_e_Square
	注释类型：矩形注释。<PDF参考1.7>中的标准注释之一。

	e_Squiggly = _fsdk.Annot_e_Squiggly
	注释类型：波浪线注释。<PDF参考1.7>中的标准注释之一。

	e_Stamp = _fsdk.Annot_e_Stamp
	注释类型：印章注释。<PDF参考1.7>中的标准注释之一。

	e_StrikeOut = _fsdk.Annot_e_StrikeOut
	注释类型：删除线注释。<PDF参考1.7>中的标准注释之一。

	e_TrapNet = _fsdk.Annot_e_TrapNet
	注释类型：陷阱网络注释。<PDF参考1.7>中的标准注释之一。

	e_Underline = _fsdk.Annot_e_Underline
	注释类型：下划线注释。<PDF参考1.7>中的标准注释之一。

	e_UnknownType = _fsdk.Annot_e_UnknownType
	注释类型：未知。

	e_Watermark = _fsdk.Annot_e_Watermark
	注释类型：水印注释。<PDF参考1.7>中的标准注释之一。

	e_Widget = _fsdk.Annot_e_Widget
	注释类型：小组件注释。<PDF参考1.7>中的标准注释之一。更多...

详细描述

自由文本注释直接在页面上显示文本。因此自由文本注释不需要相关的弹出注释来显示文本。
自由文本注释是一种标记注释，所以类FreeText 派生自类Markup ，并且还提供了获取/设置自由文本注释属性和重置自由文本注释外观流的函数。

注解: 对于新创建的自由文本注释，如果用户直接调用函数FoxitPDFSDKPython2.Annot.ResetAppearanceStream 而不设置任何属性，将使用默认外观：
边框宽度 = 1.0，边框样式 = FoxitPDFSDKPython2.BorderInfo.e_Solid ，边框颜色 = 0xFFFF0000（红色），不透明度 = 1.0，对齐方式 = 0（左对齐），默认外观标志 = FoxitPDFSDKPython2.DefaultAppearance.e_FlagFont | FoxitPDFSDKPython2.DefaultAppearance.e_FlagTextColor | FoxitPDFSDKPython2.DefaultAppearance.e_FlagFontSize ，默认外观字体基于FoxitPDFSDKPython2.Font.e_StdIDHelvetica 创建，默认外观文本大小 = 12，默认外观文本颜色 = 0xFF0000FF（蓝色）。

参见: Markup

构造及析构函数说明

◆ FreeText()

def FoxitPDFSDKPython2.FreeText.FreeText ( annot )

构造函数，使用父类对象。

参数

[in] annot 父类对象。

成员函数说明

◆ AllowTextOverflow()

def FoxitPDFSDKPython2.FreeText.AllowTextOverflow ( is_text_overflow )

决定是否允许自由文本的文本溢出。

对于标注对象和文本框对象，如果未调用此函数，默认情况下标注或文本框的文本允许溢出。对于打字机对象，如果未调用此函数，默认情况下打字机的文本不允许溢出。

参数

[in]

is_text_overflow

决定当自由文本矩形的大小小于文本内容大小时，是否允许文本内容溢出的布尔值：

true表示文本内容允许溢出。在这种情况下，溢出的文本内容将被截断。
false表示文本内容不允许溢出。在这种情况下，标注矩形将自动适应以包含整个文本内容。

返回: 无。

◆ GetAlignment()

def FoxitPDFSDKPython2.FreeText.GetAlignment ( )

弃用:: 当前函数自福昕PDF SDK 8.2起已被弃用。此属性将不再对自由文本注释的外观产生任何影响。要获取对齐属性，请调用函数FoxitPDFSDKPython2.Markup.GetRichTextStyle 。有关RichText相关函数的更多详细信息，请参考Markup 。

此属性对自由文本注释的外观有影响。

返回: 对齐值。请参考从FoxitPDFSDKPython2.e_AlignmentLeft 开始的值，这将是这些值中的一个。

◆ GetCalloutLineEndingStyle()

def FoxitPDFSDKPython2.FreeText.GetCalloutLineEndingStyle ( )

获取标注线起点的线条结束样式。

只有当自由文本注释的意图名称为"FreeTextCallout"时，此自由文本注释才能具有线条结束样式属性，且此属性对这种自由文本注释的外观有影响。

返回: 起点的线条结束样式。请参考从FoxitPDFSDKPython2.Markup.e_EndingStyleNone 开始的值，这将是这些值中的一个。

◆ GetCalloutLinePoints()

def FoxitPDFSDKPython2.FreeText.GetCalloutLinePoints ( )

获取标注线点。

只有当自由文本注释的意图名称为"FreeTextCallout"时，此自由文本注释才能具有标注线点属性，且此属性对这种自由文本注释的外观有影响。对于标注线，它可以包含2个或3个点：

2个点表示标注线的起点和终点。
3个点表示标注线的起点、拐点和终点。

返回: 表示标注自由文本注释的标注线所用点的点数组。

◆ GetDefaultAppearance()

def FoxitPDFSDKPython2.FreeText.GetDefaultAppearance ( )

获取默认外观数据。

此属性对自由文本注释的外观有影响。默认外观数据可用于格式化文本。

返回: 默认外观数据。

◆ GetFillColor()

def FoxitPDFSDKPython2.FreeText.GetFillColor ( )

获取填充颜色。

此属性对自由文本注释的外观有影响。填充颜色用于填充文本框的背景，也用于某些标注线结束样式：
"Square"、"Circle"、"Diamond"、"ClosedArrow"、"RClosedArrow"。

返回: 填充颜色。格式：0xRRGGBB。如果找不到填充颜色，将返回0x000000。

◆ GetInnerRect()

def FoxitPDFSDKPython2.FreeText.GetInnerRect ( )

获取内部矩形。

此属性对自由文本注释的外观有影响。对于自由文本注释，内部矩形是应该显示注释文本的位置。内部矩形可能与注释矩形相同或小于注释矩形，但绝不应大于注释矩形。

返回: 内部矩形。

◆ GetRotation()

def FoxitPDFSDKPython2.FreeText.GetRotation ( )

获取当前旋转值（顺时针）。

返回: 当前旋转值（顺时针）。请参考从FoxitPDFSDKPython2.e_Rotation0 开始的值，这将是这些值中的一个。

◆ GetTextMatrix()

def FoxitPDFSDKPython2.FreeText.GetTextMatrix ( )

弃用:: 当前函数自福昕PDF SDK 7.4起已被弃用。此属性将不再对注释外观产生任何影响。

此属性对自由文本注释的外观有影响。此属性可用于改变文本显示的倾斜度。

返回: 默认外观中用于文本的矩阵。

◆ Rotate()

def FoxitPDFSDKPython2.FreeText.Rotate ( rotation )

从当前状态按指定旋转值（顺时针）旋转当前注释。

参数

[in] rotation 表示用于从当前状态顺时针旋转当前注释的度数的旋转值。请参考从FoxitPDFSDKPython2.e_Rotation0 开始的值，这应该是这些值中的一个，除了FoxitPDFSDKPython2.e_RotationUnknown 。特别地，如果输入值是FoxitPDFSDKPython2.e_Rotation0 （意味着不旋转当前注释），当前函数将不执行任何操作。

返回: true表示成功，而false表示失败。

◆ SetAlignment()

def FoxitPDFSDKPython2.FreeText.SetAlignment ( alignment )

弃用:: 当前函数自福昕PDF SDK 8.2起已被弃用。此属性将不再对自由文本注释的外观产生任何影响。要设置对齐属性，请调用函数FoxitPDFSDKPython2.Markup.SetRichTextStyle 。有关RichText相关函数的更多详细信息，请参考Markup 。

此属性对自由文本注释的外观有影响。如果用户希望新的对齐方式对注释外观产生效果，请在设置新对齐方式后调用函数FoxitPDFSDKPython2.Annot.ResetAppearanceStream 。

参数

[in] alignment 新的对齐值。请参考从FoxitPDFSDKPython2.e_AlignmentLeft 开始的值，这应该是这些值中的一个。
如果使用其他值进行设置，默认将使用FoxitPDFSDKPython2.e_AlignmentLeft 。

返回: 无。

◆ SetCalloutLineEndingStyle()

def FoxitPDFSDKPython2.FreeText.SetCalloutLineEndingStyle ( ending_style )

设置标注线起点的线条结束样式。

只有当自由文本注释的意图名称为"FreeTextCallout"时，此自由文本注释才能具有线条结束样式属性，且此属性对这种自由文本注释的外观有影响。
如果用户希望新的线条结束样式对注释外观产生效果，请在设置新线条结束样式后调用函数FoxitPDFSDKPython2.Annot.ResetAppearanceStream 。

参数

[in] ending_style 要设置的起点线条结束样式。请参考从 FoxitPDFSDKPython2.Markup.e_EndingStyleNone 开始的值，这应该是这些值中的一个。

返回: 无。

◆ SetCalloutLinePoints()

def FoxitPDFSDKPython2.FreeText.SetCalloutLinePoints ( point_array )

设置标注线的点。

只有当自由文本注释的意图名称为"FreeTextCallout"时，此自由文本注释才能具有标注线点属性，且此属性对这种自由文本注释的外观有影响。对于标注线，它可以包含2个或3个点：

2个点表示标注线的起点和终点。
3个点表示标注线的起点、拐点和终点。

如果用户希望新的标注线点对注释外观产生效果，请在设置新标注线点后调用函数FoxitPDFSDKPython2.Annot.ResetAppearanceStream 。

参数

[in] point_array 指定标注线起点、拐点（如果有）和终点的新点数组。元素数量应为2或3： 2个点表示起点和终点；3个点表示起点、拐点和终点。
如果元素数量超过3，只有前3个点将被用于设置标注线。

返回: 无。

◆ SetDefaultAppearance()

def FoxitPDFSDKPython2.FreeText.SetDefaultAppearance ( default_ap )

设置默认外观数据。

此属性对自由文本注释的外观有影响。默认外观数据可用于格式化文本。
如果用户希望新的默认外观数据对注释外观产生效果，请在设置新默认外观数据后调用函数FoxitPDFSDKPython2.Annot.ResetAppearanceStream 。

参数

[in] default_ap 要设置的新默认外观数据。输入数据的flags可用于决定哪些信息将用新数据更新；对于那些不更新的数据，它们将继续使用旧数据。

返回

true表示成功，而false表示失败。特别地，如果参数default_ap包含任何不正确的值，此函数将返回false，例如：

输入数据的flags包含FoxitPDFSDKPython2.DefaultAppearance.e_FlagFont 但输入数据的font无效。
输入数据的flags包含FoxitPDFSDKPython2.DefaultAppearance.e_FlagFontSize 但输入数据的text size不大于零。

◆ SetFillColor()

def FoxitPDFSDKPython2.FreeText.SetFillColor ( fill_color )

设置填充颜色。

此属性对自由文本注释的外观有影响。填充颜色用于填充文本框的背景，也用于某些标注线结束样式：
"Square"、"Circle"、"Diamond"、"ClosedArrow"、"RClosedArrow"。
如果用户希望新的填充颜色对注释外观产生效果，请在设置新填充颜色后调用函数FoxitPDFSDKPython2.Annot.ResetAppearanceStream 。

参数

[in] fill_color 要设置的新填充颜色。格式：0xRRGGBB。

返回: 无。

◆ SetInnerRect()

def FoxitPDFSDKPython2.FreeText.SetInnerRect ( inner_rect )

设置内部矩形。

此属性对自由文本注释的外观有影响。对于自由文本注释，内部矩形是应该显示注释文本的位置。内部矩形可能与注释矩形相同或小于注释矩形，但绝不应大于注释矩形。
如果用户希望新的内部矩形对注释外观产生效果，请在设置新内部矩形后调用函数FoxitPDFSDKPython2.Annot.ResetAppearanceStream 。

参数

[in] inner_rect 要设置的新内部矩形。它应该与注释矩形相同或小于注释矩形。

返回: 无。

◆ SetRotation()

def FoxitPDFSDKPython2.FreeText.SetRotation ( rotation )

设置旋转值（顺时针）。

此属性对自由文本注释的外观有影响。如果用户希望新的旋转对注释外观产生效果，请在设置新旋转后调用函数 FoxitPDFSDKPython2.Annot.ResetAppearanceStream 。

参数

[in] rotation 要设置给当前自由文本注释的新旋转值（顺时针）。请参考从FoxitPDFSDKPython2.e_Rotation0 开始的值，这应该是这些值中的一个，除了FoxitPDFSDKPython2.e_RotationUnknown 。

返回: 无。

◆ SetTextMatrix()

def FoxitPDFSDKPython2.FreeText.SetTextMatrix ( text_matrix )

弃用:: 当前函数自福昕PDF SDK 7.4起已被弃用。此属性将不再对注释外观产生任何影响。

此属性对自由文本注释的外观有影响。此属性可用于改变文本显示的倾斜度。
如果用户希望新的文本矩阵对注释外观产生效果，请在设置新文本矩阵后调用函数FoxitPDFSDKPython2.Annot.ResetAppearanceStream 。

参数

[in] text_matrix 新的文本矩阵。

返回: 无。

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ FreeText()

成员函数说明

◆ AllowTextOverflow()

◆ GetAlignment()

◆ GetCalloutLineEndingStyle()

◆ GetCalloutLinePoints()

◆ GetDefaultAppearance()

◆ GetFillColor()

◆ GetInnerRect()

◆ GetRotation()

◆ GetTextMatrix()

◆ Rotate()

◆ SetAlignment()

◆ SetCalloutLineEndingStyle()

◆ SetCalloutLinePoints()

◆ SetDefaultAppearance()

◆ SetFillColor()

◆ SetInnerRect()

◆ SetRotation()

◆ SetTextMatrix()